/*
 * Copyright 2011 Carnegie Mellon University
 * Licensed under the Apache License, Version 2.0 (the "License"); 
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *  
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, 
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied. See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
package edu.cmu.lti.ritesdk;

import java.util.LinkedHashMap;
import java.util.Map;

/**
 * Stores evaluation results.
 * Score is represented as a map where the key is a metric name and the value is a metric score
 * This design allows arbitrary metric to be reported.
 * To store representation in score (e.g. primitive type, digits to show), values are stored as String.
 * 
 * @author Hideki Shima
 *
 */
public class EvaluationResult {

  //metric scores
  private Map<String,String> score = new LinkedHashMap<String,String>();
  
  //brief textual evaluation result
  private String evaluationSummary;
  
  //detailed evaluation log
  private String evaluationDetail;

  public EvaluationResult(Map<String,String> score, String evaluationSummary, String evaluationDetail) {
    this.score = score;
    this.evaluationSummary = evaluationSummary;
    this.evaluationDetail = evaluationDetail;
  }
  
  public String getEvaluationSummary() {
    return evaluationSummary;
  }

  public void setEvaluationSummary(String evaluationSummary) {
    this.evaluationSummary = evaluationSummary;
  }

  public Map<String, String> getScore() {
    return score;
  }

  public void setScore(Map<String, String> score) {
    this.score = score;
  }

  public String getEvaluationDetail() {
    return evaluationDetail;
  }

  public void setEvaluationDetail(String evaluationDetail) {
    this.evaluationDetail = evaluationDetail;
  }
  
}
